Skip to main content

Webhook: TASK_EDITED

Описание​

Webhook TASK_EDITED срабатывает каждый раз, когда существующая задача изменяется. Это уведомление позволяет системам или пользователям отслеживать изменения в деталях задачи в реальном времени.

Формат запроса​

Webhook отправляется в виде HTTP POST запроса с следующим пейлоадом:

{
   "entityId": "1d63907b-93ed-4188-8b5d-99292fceaae9",
   "type": "TASK_EDITED",
   "createdAt": "2024-12-16T09:50:29.775Z",
   "data": {
      "operation": "UPDATE",
      "current": {
         "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "startAt": "2024-12-16T09:00:00.000Z",
         "endAt": "2024-12-16T13:00:00.000Z",
         "name": "Task 2",
         "assigneeIds": [
            "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
         ],
         "recurrenceRule": null
      },
      "previous": {
         "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "startAt": "2024-12-16T09:00:00.000Z",
         "endAt": "2024-12-16T11:15:00.000Z",
         "name": "Task 2",
         "assigneeIds": [
            "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
         ],
         "recurrenceRule": null
      }
   }
}

Ключевые свойства​

Верхний уровень​

  • entityId: Уникальный идентификатор измененной задачи.
  • type: Указывает тип webhook (TASK_EDITED).
  • createdAt: Временная метка срабатывания webhook в формате ISO 8601.
  • data: Содержит детали изменения.

Раздел данных​

  • operation: Указывает тип операции, выполненной над задачей (UPDATE).
  • current: Отражает обновленные свойства задачи.
  • previous: Отражает свойства задачи до обновления.

Свойства задачи​

Эти свойства присутствуют в разделах current и previous:

  • id: Уникальный идентификатор задачи.
  • organizationId: Идентификатор организации, связанной с задачей.
  • locationId: Идентификатор местоположения, где назначена задача.
  • startAt: Время начала задачи в формате ISO 8601.
  • endAt: Время завершения задачи в формате ISO 8601.
  • name: Название задачи.
  • assigneeIds: Список идентификаторов пользователей, назначенных на задачу.
  • recurrenceRule: Детали повторения задачи (если применимо).

Пример ответа​

Пример пейлоада, подтверждающего получение webhook:

{
   "entityId": "1d63907b-93ed-4188-8b5d-99292fceaae9",
   "type": "TASK_EDITED",
   "createdAt": "2024-12-16T09:50:29.775Z",
   "data": {
      "operation": "UPDATE",
      "current": {
         "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "startAt": "2024-12-16T09:00:00.000Z",
         "endAt": "2024-12-16T13:00:00.000Z",
         "name": "Task 2",
         "assigneeIds": [
            "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
         ],
         "recurrenceRule": null
      },
      "previous": {
         "id": "1d63907b-93ed-4188-8b5d-99292fceaae9",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "startAt": "2024-12-16T09:00:00.000Z",
         "endAt": "2024-12-16T11:15:00.000Z",
         "name": "Task 2",
         "assigneeIds": [
            "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
         ],
         "recurrenceRule": null
      }
   },
   "id": 201
}

Преимущества webhook TASK_EDITED​

  1. Отслеживание изменений: Обеспечивает видимость того, что изменилось в задаче.
  2. Прогнозируемые обновления: Уведомляет системы или пользователей о модификациях задачи в реальном времени.
  3. Аудит: Позволяет отслеживать историю изменений задачи и обеспечивать подотчетность.

Используя webhook TASK_EDITED, организации могут оперативно отслеживать изменения в задачах и адаптировать рабочие процессы или процессы соответственно.